Skip to content

chore(template): Add Helm helper for telemetry env vars #501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 7 commits into from
Apr 14, 2025
Merged

chore(template): Add Helm helper for telemetry env vars #501

merged 7 commits into from
Apr 14, 2025

Conversation

@Techassi
Copy link
Member

@Techassi Techassi commented Apr 10, 2025 •
edited
Loading

Part of stackabletech/issues#639

Depends on

This adds the telemetry.envVars Helm helper to create a list of environment variables passed on the .telemetry values.

Example

Given these values form the Helm values.yaml file

telemetry:
  consoleLog:
    enabled: false
    level: warn
    format: json
  fileLog:
    enabled: true
    level: debug
    rotationPeriod: hourly
    maxFiles: 6
  otelLogExporter:
    enabled: true
    level: trace
    endpoint: my-collector:4317
  otelTraceExporter:
    enabled: true
    level: error
    endpoint: my-collector:4317

the rendered env block in the Deployment looks like

apiVersion: apps/v1
kind: Deployment
metadata:
  name: foo-operator-airflow-operator-deployment
spec:
  template:
    spec:
      containers:
        - name: airflow-operator
          env:
            - name: CONSOLE_LOG_DISABLED
              value: "true"
            - name: CONSOLE_LOG_LEVEL
              value: warn
            - name: CONSOLE_LOG_FORMAT
              value: json
            - name: FILE_LOG_DIRECTORY
              value: /stackable/logs/airflow-operator
            - name: FILE_LOG_LEVEL
              value: debug
            - name: FILE_LOG_ROTATION_PERIOD
              value: hourly
            - name: FILE_LOG_MAX_FILES
              value: 6
            - name: OTEL_LOG_EXPORTER_ENABLED
              value: "true"
            - name: OTEL_LOG_EXPORTER_LEVEL
              value: trace
            - name: OTEL_EXPORTER_OTLP_LOGS_ENDPOINT
              value: my-collector:4317
            - name: OTEL_TRACE_EXPORTER_ENABLED
              value: "true"
            - name: OTEL_TRACE_EXPORTER_LEVEL
              value: error
            - name: OTEL_EXPORTER_OTLP_TRACES_ENDPOINT
              value: my-collector:4317

Default values will be set according to the design laid out in the tracking issue.

@Techassi Techassi self-assigned this Apr 10, 2025
@Techassi Techassi moved this to Development: In Progress in Stackable Engineering Apr 10, 2025
@Techassi Techassi mentioned this pull request Apr 10, 2025
Closed
@Techassi Techassi moved this from Development: In Progress to Development: Waiting for Review in Stackable Engineering Apr 11, 2025
@Techassi Techassi requested a review from NickLarsenNZ April 11, 2025 12:22
@NickLarsenNZ NickLarsenNZ moved this from Development: Waiting for Review to Development: In Review in Stackable Engineering Apr 11, 2025
NickLarsenNZ
NickLarsenNZ previously approved these changes Apr 11, 2025
View reviewed changes
Copy link
Member

@NickLarsenNZ NickLarsenNZ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@NickLarsenNZ NickLarsenNZ added the release-note Denotes a PR that will be considered when it comes time to generate release notes. label Apr 11, 2025
@NickLarsenNZ
Copy link
Member

NickLarsenNZ commented Apr 11, 2025 •
edited
Loading

Release Note

All operators now have access to these telemetry related Helm values. These are the defaults:

telemetry:
  consoleLog:
    enabled: true
    level: null
    format: null
  fileLog:
    enabled: false
    level: null
    rotationPeriod: null
    maxFiles: null
  otelLogExporter:
    enabled: false
    level: null
    endpoint: null
  otelTraceExporter:
    enabled: false
    level: null
    endpoint: null

@Techassi Techassi enabled auto-merge April 14, 2025 14:47
NickLarsenNZ
NickLarsenNZ approved these changes Apr 14, 2025
View reviewed changes
Copy link
Member

@NickLarsenNZ NickLarsenNZ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Techassi Techassi added this pull request to the merge queue Apr 14, 2025
Merged via the queue into main with commit 1ba8fc4 Apr 14, 2025
2 checks passed
@Techassi Techassi deleted the chore/template-telemetry-helper branch April 14, 2025 15:23
@Techassi Techassi mentioned this pull request Apr 15, 2025
Merged
@Techassi Techassi moved this from Development: In Review to Development: Done in Stackable Engineering Apr 16, 2025
@lfrancke lfrancke moved this from Development: Done to Done in Stackable Engineering Apr 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@NickLarsenNZ NickLarsenNZ NickLarsenNZ approved these changes

Assignees

@Techassi Techassi

Labels

release-note Denotes a PR that will be considered when it comes time to generate release notes. scheduled-for/25.7.0

Projects

Stackable Engineering
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Techassi @NickLarsenNZ